home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / COMM / CBOX11.ARJ / CHATBOX.DOC < prev    next >
Text File  |  1991-08-10  |  45KB  |  1,037 lines

  1.          
  2.  
  3.  
  4.  
  5.  
  6.          ------------------------------------------------------------------
  7.         |                                                                  |
  8.         |                                                                  |
  9.         |                                                                  |
  10.         |                                                                  |
  11.         |                                                                  |
  12.         |                        ChatBox Version 1.1                       |
  13.         |                                                                  |
  14.         |            Split-Screen Sysop Chat - Caller Page Door            |
  15.         |                                                                  |
  16.         |                                                                  |
  17.         |                               For                                |
  18.         |                                                                  |
  19.         |                  PCBoard Versions 14.5 & 14.5a                   |
  20.         |                                                                  |
  21.         |                                                                  |
  22.         |             Horizontal or Vertical Split-Screen Chat             |
  23.         |                                                                  |
  24.         |                                                                  |
  25.         |    Sysop Configurable Page Sounds (Beeping, Telephone Ringing)   |
  26.         |                                                                  |
  27.         |                                                                  |
  28.         |          Sysop may choose Flashing "Silent Page" Mode            |
  29.         |                                                                  |
  30.         |                                                                  |
  31.         |          Uses PCBTEXT - Completely Language Compatible           |
  32.         |                                                                  |
  33.         |                                                                  |
  34.         |      Seamless Appearance when used as a "Shelled-to" Door        |
  35.         |                                                                  |
  36.         |                                                                  |
  37.         |                All Options Are Sysop-Configurable                |
  38.         |                                                                  |
  39.         |                                                                  |
  40.         |                                                                  |
  41.         |                       ChatBox Version 1.1                        |
  42.         |                                                                  |
  43.         |         (C) Copyright 1991   Yandell Computer Services           |
  44.         |                                                                  |
  45.         |             12121 Little Road - Bldg. 303 - Suite 212            |
  46.         |                        Hudson, FL 34667                          |
  47.         |                                                                  |
  48.         |                   DATA -- (813) 842-8099 (HST)                   |
  49.         |                                                                  |
  50.         |                                                                  |
  51.         |                         August 10, 1991                          |
  52.         |                                                                  |
  53.         |                                                                  |
  54.         |                                                                  |
  55.          ------------------------------------------------------------------ 
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.         --------------------------------------------------------------------
  70.                                       ChatBox
  71.         --------------------------------------------------------------------
  72.  
  73.                                  TABLE OF CONTENTS                      Page
  74.                                  -----------------                      ----
  75.  
  76.               INTRODUCTION                                                 
  77.               ------------
  78.               1.0  What Is ChatBox                                         3
  79.               1.1  What Is New in Version 1.1                              3
  80.               1.2  Multi-Nodes, Networks, Multi-taskers                    3
  81.                
  82.               INSTALLING ChatBox
  83.               ------------------
  84.               2.0  Preliminaries                                           4
  85.               2.1  Configuring PCBoard Door Files                          4
  86.               2.2  Setting Up Door Batch Files                             5
  87.               2.3  Running CBSETUP and Creating CHATBOX.CNF              6-9
  88.               2.4  Setting Up for Sysop Initiated Chats                   10
  89.               2.5  Setting Up for Multi-Language Use                      11
  90.               2.6  Setting Up V.I.P. Callers (CHATBOX.VIP)                11
  91.               2.7  Setting Up PCBoard for an Alternate Chat Device.       11
  92.                             
  93.               RUN-TIME CONSIDERATIONS
  94.               -----------------------
  95.               3.0  Notes Regarding PCBTEXT Files                          12
  96.               3.1  Notes Regarding the F4 Function Key                    13
  97.               3.2  Notes Regarding SOUND.BAT                              13
  98.               3.3  Notes Regarding Text File Displays                     13
  99.  
  100.               MISCELLANEOUS
  101.               ------------- 
  102.               4.0  Sysop Function Keys                                    14
  103.               4.1  Technical Notes                                        14
  104.               4.2  Caller Log Entries                                     14
  105.               4.3  Error Messages                                         15
  106.               4.4  Where to Receive Assistance                            15
  107.               4.5  Disclaimer and Warranty                                15
  108.               4.6  About the Author                                       15
  109.               4.7  Acknowledgments                                        16
  110.               4.8  Revision History                                       16
  111.                   
  112.               REGISTRATION       
  113.               ------------
  114.               5.0  Registering ChatBox                                    16
  115.  
  116.         
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.         --------------------------------------------------------------------
  136.         Page 3                        ChatBox                         Page 3
  137.         --------------------------------------------------------------------
  138.  
  139.         1.0  What is ChatBox
  140.         --------------------
  141.         ChatBox  is  a Split-Screen chat utility designed for  PCBoard.  The 
  142.         Sysop may select the Split-Screen format for chatting. In horizontal
  143.         mode, the screen is split into two halves (boxes), upper and  lower.  
  144.         In vertical mode, the screen is split into two halves (boxes),  left 
  145.         and right. 
  146.  
  147.         The  Sysop  may initiate the chat.  ChatBox will bypass  its  paging 
  148.         process and go directly into chat mode if initiated by the Sysop.
  149.    
  150.         Split-Screen chatting allows simultaneous typing between  the  Sysop
  151.         and the caller.
  152.  
  153.         ChatBox allows the  Sysop to select the type of sound  made  when  a 
  154.         caller is paging.  A different tone may be selected for the familiar 
  155.         "beep-beep",  or one of several different telephone  ringing  sounds 
  156.         may be chosen. A special "silent mode" may be selected which flashes 
  157.         a large white box on the screen. This mode is especially helpful for 
  158.         hearing impaired Sysops.  Sysops may choose to "shell" to their  own
  159.         noise  making or screen flashing program to alert them a  caller  is 
  160.         requesting an on-line chat.
  161.          
  162.         Three  different paging time periods may be configured for each  day 
  163.         of the week.
  164.  
  165.         Split-Screen chat colors may be configured by the Sysop  (registered
  166.         copies of ChatBox only).
  167.  
  168.         ChatBox uses PCBTEXT for multi-language compatibility and additional 
  169.         flexibility.
  170.           
  171.         ChatBox is completely DESQview aware.
  172.  
  173.         ChatBox works with non-standard com ports automatically.
  174.  
  175.  
  176.         1.1  What is new in version 1.1
  177.         -------------------------------
  178.         Please  refer  to the enclosed file FEATURES.NEW for a list  of  new 
  179.         features in ChatBox version 1.1.
  180.  
  181.  
  182.         1.2  Multi-nodes, networks, multi-taskers
  183.         -----------------------------------------
  184.         ChatBox  has been developed in a networked environment.  All  multi-
  185.         node  features are thoroughly tested on our own  multi-node  PCBoard 
  186.         system.  Two  of ChatBox's primary beta test facilities  are  twenty 
  187.         node systems.
  188.         
  189.         ChatBox is DESQview aware.  It is automatically detected, screen and 
  190.         keyboard  I/O are "well behaved", and time slices are given back  to 
  191.         other applications while ChatBox is idle. 
  192.                     
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.         --------------------------------------------------------------------
  202.         Page 4                       ChatBox                          Page 4
  203.         --------------------------------------------------------------------
  204.  
  205.         2.0  Preliminaries
  206.         ------------------
  207.         Create  a directory or subdirectory where you normally place  doors. 
  208.         Extract the entire contents of CBOX11.ZIP into this location.
  209.  
  210.           
  211.         2.1  Configuring PCBoard Door Files
  212.         -----------------------------------
  213.         Install  a door called PAGE into your DOOR.LST file using  PCBSETUP. 
  214.         Answer the following questions as follows:
  215.  
  216.                                          USER DOOR
  217.           Filename   Password  Sec Login SYS  SYS  Shell Path to DOOR Files
  218.           --------   --------  --- ----- ---  ---  ----- ------------------
  219.         #) PAGE                 10   N    Y    N     Y   (if appropriate)
  220.  
  221.  
  222.         Note  the use of PAGE as a door name, not CHATBOX, as you will  most 
  223.         likely want to place PAGE as a command on your main menu (BRDM). 
  224.   
  225.         A password would usually not be required for your PAGE door.
  226.  
  227.         A  low  security level is required, as you may  also be  using  this 
  228.         same door when you wish to initiate a chat with the caller.  ChatBox
  229.         follows  the security level for the "O" command in PCBoard.  Callers 
  230.         who  are  below this level will not be able to use ChatBox  to  page 
  231.         you.
  232.  
  233.         A  USERS.SYS file MUST be created. ChatBox will not run without  it, 
  234.         as ChatBox NEVER touches the USERS file.
  235.           
  236.         A DOOR.SYS file is NOT needed.
  237.           
  238.         If running PCBoard 14.5a, shelling is HIGHLY recommended because  it 
  239.         greatly increases the speed at which PCBoard returns when the caller 
  240.         exits  from  ChatBox. ChatBox has been specifically  designed  as  a 
  241.         "Shell"  door. Setting up ChatBox as a "swapped shell" door  is  not 
  242.         recommended  unless it is needed due to memory limitations.  ChatBox 
  243.         only requires about 69K of memory so "swapping" the "shell to"  door 
  244.         should not be required.
  245.  
  246.         If  you have different DOOR.LST files in your conferences, you  will 
  247.         need to configure the PAGE door in them also.
  248.  
  249.         It  is up to the individual Sysop as to whether or not to place  the 
  250.         PAGE command in the doors menu, or as a command on the main menu, or  
  251.         both.  The recommended usage is to place PAGE on the main  menu  and 
  252.         not in the doors menu.
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.         --------------------------------------------------------------------
  268.         Page 5                        ChatBox                         Page 5
  269.         --------------------------------------------------------------------
  270.                          
  271.         2.2  Setting up door batch files
  272.         --------------------------------
  273.         The  purpose of this section is to explain the command line  calling 
  274.         syntax for ChatBox.  Please refer to the PCBoard manual for  a  more 
  275.         complete  discussion  on door batch file installation.  If  you have 
  276.         named  the door PAGE (recommended) the following examples  would  be 
  277.         the contents of your door file named PAGE.
  278.                               
  279.         *PREFERRED METHOD* (fast load!)
  280.         -------------------------------
  281.         @echo off
  282.         C:\CHATBOX\CHATBOX.EXE  CHATBOX.CNF  C:\PCB                            
  283.         ----------------------  -----------  ------                            
  284.                 |               |            |-> This node's home directory.
  285.                 |               |               
  286.                 |               |                                            
  287.                 |                ---------> The name of the configuration    
  288.                 |                           file. Enter a file NAME only.    
  289.                 |                           NEVER place a location here. 
  290.                 |                                                        
  291.                  -------> The executable file name.  Placing its location
  292.                           in-line as shown results in MUCH faster response
  293.                           time in executing the door.    
  294.                                     
  295.         The two lines above are all that is required to execute ChatBox when 
  296.         running  as  a  shelled-to door in PCBoard 14.5a.  If  you  are  not 
  297.         running PCBoard 14.5a or you are not running ChatBox as a shelled-to 
  298.         door,  add the call to BOARD.BAT as the third command  in  the  door 
  299.         file  Do NOT end your door file with BOARD.BAT if running ChatBox as 
  300.         a shell-to door in PCBoard 14.5a.
  301.  
  302.  
  303.         *OLD FASHIONED METHOD* (tried and true, but slow load)
  304.         ------------------------------------------------------
  305.         @echo off
  306.         d:                                                                    
  307.         cd\chatbox
  308.         CHATBOX.EXE  CHATBOX.CNF  C:\PCB                            
  309.         c:                        ------                            
  310.         cd\pcb                       |-> This node's home directory. 
  311.                                          
  312.                                          
  313.           
  314.         The  above method will work fine with ChatBox. The only drawback  is 
  315.         the  slower loading time as a result of the changing of  drives  and 
  316.         directories  in  DOS.  As  with the  "preferred  method",  only  add 
  317.         BOARD.BAT  to  the end of the door file if you are NOT  shelling  to 
  318.         ChatBox in PCBoard 14.5a, or if you are running PCBoard 14.5.
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.         --------------------------------------------------------------------
  334.         Page 6                        ChatBox                         Page 6
  335.         --------------------------------------------------------------------
  336.  
  337.         2.3  Running CBSETUP and creating CHATBOX.CNF
  338.         ---------------------------------------------
  339.         Enclosed with ChatBox 1.1 is a file called  CBSETUP.EXE.  This  file 
  340.         allows  you  to easily and quickly configure  ChatBox  configuration 
  341.         files.  Only one CHATBOX.CNF file is required for all nodes.  Please 
  342.         refer to section 2.5 page 11 for information on creating CHATBOX.CNF
  343.         files for multi-language use.
  344.                                                                       
  345.         To  start  CBSETUP.EXE, enter CBSETUP CHATBOX.CNF at your DOS prompt 
  346.         (CHATBOX.CNF would be the appropriate configuration file).   
  347.  
  348.         Each parameter in CBSETUP is described on the following pages.
  349.           
  350.  
  351.         * ChatBox registration number 
  352.         ---------------------------
  353.         This is the registration number received when ChatBox is registered. 
  354.           
  355.         Registration  causes the ChatBox [ UNREGISTERED COPY ]  message  and 
  356.         the brief delay at program termination to disappear. This message is 
  357.         not replaced with your board name or anything else. The entire  line 
  358.         completely  disappears for  a true, seamless, "looks  like  PCBoard" 
  359.         process if running as a shelled-to door in PCBoard 14.5a.  
  360.           
  361.         Registration also allows ChatBox to use the Sysop defined colors for 
  362.         Split-Screen chat operations.
  363.  
  364.  
  365.         * Default chat screen type
  366.         --------------------------
  367.         You  may select the initial type of Split-Screen chat mode  to begin 
  368.         the on-line chat session in. The valid selections are:
  369.  
  370.         (1)  Horizontal Split-Screen.  The Sysop will be in the top  half of 
  371.              the screen, the caller will be in the bottom half.
  372.  
  373.         (2)  Vertical Split-Screen.  The Sysop will be in the left hand side
  374.              of the screen, the caller will be in the right hand side.
  375.  
  376.         (3)  Regular non-split screen.  Self explanatory.
  377.  
  378.         (4)  Vertical Split-Screen if caller is at  9600+  baud,  Horizontal
  379.              Split-Screen if caller is less than 9600 baud.
  380.  
  381.         ChatBox  will begin the chat in the mode specified here  unless  the 
  382.         caller is at or below the baud rate specified in the "Baud  rate for
  383.         regular  chat"  parameter. If the caller is at or  below  this  baud 
  384.         rate, the chat will begin in the regular, non-split screen mode.
  385.  
  386.         If it is determined that the caller's communications program is  not 
  387.         ANSI capable, ChatBox will start the chat in the regular,  non-split 
  388.         screen mode.
  389.  
  390.  
  391.                        Section 2.3 continues on the next page
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.         --------------------------------------------------------------------
  400.         Page 7                        ChatBox                         Page 7
  401.         --------------------------------------------------------------------
  402.  
  403.         2.3  Running CBSETUP and creating CHATBOX.CNF (continued)
  404.         ---------------------------------------------------------
  405.  
  406.         * Sound made when Sysop is paged
  407.         --------------------------------
  408.         You may select the type of sound ChatBox will make while paging.
  409.  
  410.         (1)  The familiar "beep beep".
  411.         (2)  The familiar "beep beep, with a lower tone than #1.
  412.         (3)  European telephone ring. Two short rings.
  413.         (4)  Telephone ring.  Low pitch.
  414.         (5)  Telephone ring.  Medium pitch.
  415.         (6)  Telephone ring.  High pitch.
  416.         (7)  Silent - Flashing box on screen.
  417.         (8)  Shell - Use another program or device for sounds or screens.
  418.   
  419.         Press F2 at this parameter to listen to the sound you have selected.
  420.  
  421.         If selecting #8 (shell) see page 13 section 3.2 for instructions  on 
  422.         creating SOUND.BAT.
  423.           
  424.         * Baud rate for 'Regular' chat
  425.         ------------------------------
  426.         If  the caller is at this baud rate or less, ChatBox will  begin  in 
  427.         the regular (non-split screen) chat mode.  Scrolling separate  parts  
  428.         of  the  screen (required in Split-Screen chat) will  usually  yield 
  429.         unfavorable results to callers connecting at 300 and 1200 baud.
  430.  
  431.         Valid  entries  here are 300, 1200, 2400, and  9600.   ChatBox  will 
  432.         always start in non-split screen mode if the caller is at 300 baud.
  433.  
  434.         * Name to Display for Sysop
  435.         ---------------------------
  436.         While in Split-Screen chat,  this name is used to identify the Sysop
  437.         in the status line for the Sysop's half of the screen.
  438.  
  439.         This name is used in the introductory  "Hello, this is  _____" text.
  440.  
  441.         This is also used if the Sysop drops to DOS in ChatBox.  It will  be 
  442.         displayed in front of appropriate "___ has exited to DOS" message.
  443.  
  444.         * Color to use for Chat Text
  445.         ----------------------------
  446.         Chat text (text the Sysop and caller type while chatting) colors may
  447.         be configured.  This color is used when the caller is in color mode.
  448.  
  449.         Pressing F2 at this parameter in CBSETUP will display a color  chart 
  450.         and sample Split-Screen chat display using the colors you've chosen.
  451.  
  452.         Chat text colors are always high intensity (bright).
  453.  
  454.         ChatBox  must be registered for this toggle to be recognized.  In an 
  455.         unregistered copy, this will default to "2" when ChatBox is run.
  456.  
  457.  
  458.                        Section 2.3 continues on the next page
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.         --------------------------------------------------------------------
  466.         Page 8                        ChatBox                         Page 8
  467.         --------------------------------------------------------------------
  468.  
  469.         2.3  Running CBSETUP and creating CHATBOX.CNF (continued)
  470.         ---------------------------------------------------------
  471.  
  472.         * Color to use for Box Lines
  473.         ----------------------------
  474.         Box line (lines creating the chat "box" while chatting)  colors  may
  475.         be configured. This color is used when the caller is in color mode.
  476.  
  477.         Pressing F2 at this parameter in CBSETUP will display a color  chart 
  478.         and sample Split-Screen chat display using the colors you've chosen.
  479.  
  480.         Chat text colors are always high intensity (bright). 
  481.  
  482.         ChatBox  must be registered for this toggle to be recognized.  In an 
  483.         unregistered copy, this will default to "6" when ChatBox is run.
  484.  
  485.  
  486.         * Color for Sysop and Caller Name
  487.         ---------------------------------
  488.         The Sysop and caller names are placed in the "box" lines  separating
  489.         each "box".  This color is used when the caller is in color mode.
  490.  
  491.         Pressing F2 at this parameter in CBSETUP will display a color  chart 
  492.         and sample Split-Screen chat display using the colors you've chosen.
  493.  
  494.         Name colors are always high intensity (bright).
  495.  
  496.         ChatBox  must be registered for this toggle to be recognized.  In an 
  497.         unregistered copy, this will default to "6" when ChatBox is run.
  498.  
  499.  
  500.         *  Reason Prompt (or NONE)
  501.         --------------------------
  502.         If ChatBox is being used to page the Sysop,  this optional parameter
  503.         may be used to ask the caller to briefly state the reason  they  are
  504.         paging the Sysop.
  505.  
  506.         If this parameter is blank or NONE is entered, this question will be
  507.         disabled in ChatBox.
  508.  
  509.         If the Sysop is initiating the chat, this parameter is ignored.
  510.  
  511.         A file name may be specified in this parameter  by starting the left
  512.         most position with a % followed by a file. If you specify a file, do
  513.         NOT specify a location.  The file must reside with CHATBOX.EXE.  For
  514.         example:
  515.         %WHY.TXT Briefly state the reason for this chat?
  516.  
  517.  
  518.  
  519.                        Section 2.3 continues on the next page
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.         --------------------------------------------------------------------
  532.         Page 9                        ChatBox                         Page 9
  533.         --------------------------------------------------------------------
  534.  
  535.         2.3  Running CBSETUP and creating CHATBOX.CNF (continued)
  536.         ---------------------------------------------------------
  537.  
  538.         * Unavailable Text
  539.         ------------------
  540.         This text is displayed when F4 is toggled off, when the caller  does
  541.         not have a sufficient access level to request a chat, or when a page
  542.         attempt goes unanswered. For example:
  543.         The Sysop is not currently available for chat.
  544.  
  545.         The above is displayed to the caller and written to the CALLER log.
  546.  
  547.         A file name may be specified in this parameter  by starting the left
  548.         most position with a % followed by a file. Do NOT specify a location
  549.         with the name. The file must reside with CHATBOX.EXE. For example:
  550.         %NO.TXT No one is available for a chat.
  551.  
  552.         NO.TXT is displayed to the caller, the text is written to CALLER(x).
  553.  
  554.  
  555.         * Hours Text
  556.         ------------
  557.         This text is displayed when a caller is requesting a chat outside of
  558.         the hours allowed for the particular day of the week. For example:
  559.         Paging is allowed hh:mm - hh:mm. Please leave a comment.
  560.  
  561.         The above is displayed to the caller and written to the CALLER log.
  562.  
  563.         A file name may be specified in this parameter  by starting the left
  564.         most position with a % followed by a file. Do NOT specify a location
  565.         with the name. The file must reside with CHATBOX.EXE. For example:
  566.         %HOURS.TXT Page is not available at this hour.
  567.  
  568.         HOURS.TXT is displayed to caller, the text is written to CALLER(x).
  569.  
  570.  
  571.         * Page Start and Stop Times
  572.         ---------------------------
  573.         You may enter 3 page starting and stopping times for each day of the
  574.         week.  Times must be entered in HH:MM format, where HH is a value of
  575.         0 through 23,  and MM is a value of 0 through 59.  CBSETUP  performs
  576.         minimal  testing of the hours input here.  Care should be  taken  to
  577.         insure the times which are input are valid and in the HH:MM format.
  578.  
  579.         To disable paging on a particular day, simply set the page times for
  580.         PERIOD 1 on that day a minute apart, such as 12:00 - 12:01, and  set
  581.         the start and stop times for PERIOD 2 and 3 to the same time.
  582.  
  583.         For 24 hour paging, set PERIOD 1 to the same start and stop times.
  584.   
  585.         PERIOD 2 or 3 is ignored if the start and stop times are the same.
  586.  
  587.         The TAB key rotates through different PERIODS in the same day.
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.         --------------------------------------------------------------------
  598.         Page 10                       ChatBox                        Page 10
  599.         --------------------------------------------------------------------
  600.  
  601.         2.4  Setting up for Sysop initiated chats
  602.         -----------------------------------------
  603.         For  the  Sysop to initiate an on-line chat using ChatBox, all  that 
  604.         needs  to  be  done is for the Sysop to type  PAGE  <enter>  at  the 
  605.         PCBoard  main  prompt. While ChatBox is loading,  you  must  quickly 
  606.         press any key on the local keyboard. When ChatBox loads and sees the 
  607.         keystroke  waiting in the local system's keyboard buffer,  it  knows 
  608.         the Sysop is initiating the chat and immediately starts in chat mode 
  609.         instead  of "paging" mode.  
  610.  
  611.         For this to function properly with all callers, you must install the 
  612.         PAGE  door in PCBoard so that all callers can access it with  a  low 
  613.         security  in  DOOR.LST. ChatBox will follow the security  level  for 
  614.         PCBoard's "O" command whenever a caller tries to page using ChatBox.
  615.           
  616.  
  617.         * Sysop Initiated Chat - AUTOMATED Method #1 :
  618.  
  619.         Using PCBSETUP, you may define the ten SHIFT-FUNCTION keys (SHIFT-F1 
  620.         through SHIFT-F10).  This is an ideal and fast way for the Sysop  to 
  621.         bring  up  the  PAGE command on the caller. Bring  up  PCBSETUP  and 
  622.         choose  one  of these keys, (SHIFT-F10 will probably be  easiest  to 
  623.         remember - F10 for PCBoard chat,  SHIFT-F10 for ChatBox).  These are 
  624.         located  on  the  Options 2 page in PCBSETUP. To  install  the  PAGE 
  625.         command, simply enter the following:
  626.           
  627.         F-Key #10 : PAGE ^M
  628.  
  629.         The  ^M must be entered exactly as shown.  
  630.  
  631.         Whenever  you wish to chat with caller, press SHIFT-F10, then  press  
  632.         any  key while ChatBox is loading to bypass the page mode and  start 
  633.         directly in chat mode (as described in the first paragraph above).
  634.  
  635.         It  is  not  possible for the caller to bring up ChatBox using  this 
  636.         method, as the caller is never capable of placing keystrokes in  the 
  637.         local (host) keyboard while ChatBox is loading.
  638.  
  639.  
  640.  
  641.         * Sysop Initiated Chat - AUTOMATED Method #2 :
  642.  
  643.         Enclosed   with   CBOX11.ZIP  are  files  called   SET_F10.EXE   and 
  644.         SET_F10.DOC.  SET_F10 is a TSR designed to be installed in BOARD.BAT 
  645.         before  calling PCBoard.  It detects Sysop F10 key presses and  asks 
  646.         if  the Sysop wants to issue the PAGE command or use PCBoard's  chat 
  647.         facility.  SET_F10 is a separate program that is released  with  the 
  648.         ChatBox program. SET_F10.DOC contains all installation and operating 
  649.         instructions.  No part of this manual (CHATBOX.DOC) other than  this 
  650.         paragraph pertains to the SET_F10 program.
  651.                                                             
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.         --------------------------------------------------------------------
  664.         Page 11                       ChatBox                        Page 11
  665.         --------------------------------------------------------------------
  666.  
  667.         2.5  Setting up for multi-language use
  668.         --------------------------------------
  669.         ChatBox  uses text from PCBTEXT or appropriate language  files  with 
  670.         the  exception of the text that is used in CHATBOX.CNF. To make  any 
  671.         text in CHATBOX.CNF language compatible, simply create  a  duplicate 
  672.         CHATBOX.CNF  file except  give it  the  appropriate  EXTension.  For 
  673.         instance with French, use the appropriate French in CHATBOX.FRE  and 
  674.         ChatBox will automatically use CHATBOX.FRE instead of CHATBOX.CNF as 
  675.         the configuration file. You do not need to worry about what  ChatBox 
  676.         is  passed in the door file. If passed CHATBOX.CNF and the  language 
  677.         is .FRE, ChatBox will look for CHATBOX.FRE before using CHATBOX.CNF.
  678.  
  679.  
  680.         2.6  Setting up V.I.P. callers (CHATBOX.VIP)
  681.         --------------------------------------------
  682.         To  create a VIP list of callers who may page at any time, create  a 
  683.         text file called CHATBOX.VIP. It must reside in the same location as 
  684.         CHATBOX.EXE. To install special names into CHATBOX.VIP, simply enter 
  685.         the  names  one at a time, with each name beginning on a  new  line. 
  686.  
  687.         Callers  who appear in CHATBOX.VIP will be able to page the Sysop at 
  688.         any time regardless of page time settings.
  689.  
  690.         Callers  who are listed in CHATBOX.VIP will NOT be able to PAGE  the 
  691.         Sysop if the F4 page bell toggle has been turned off in PCBoard.  It 
  692.         is  assumed  that if the Sysop has turned F4 off  then he\she really 
  693.         doesn't wish to disturbed. 
  694.  
  695.           
  696.         2.7  Setting up PCBoard for an alternate chat device.
  697.         -----------------------------------------------------
  698.         It  is not necessary to disable PCBoard's "O" command in  order  for 
  699.         ChatBox to function. However, if you wish to use ChatBox exclusively 
  700.         then follow these simple steps.
  701.  
  702.         1)  Set record #128 in all PCBTEXT files to:
  703.             "Please use the PAGE command for paging"
  704.           
  705.         2)  Use PCBSETUP to set the page times in  PCBOARD.DAT to one minute
  706.             apart, for example 12:00 - 12:01.
  707.                
  708.         When a caller presses "O" in PCBoard, they will receive the  "Please 
  709.         use  the PAGE command" instruction contained in record #128  of  the 
  710.         appropriate PCBTEXT file.
  711.  
  712.                               
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.  
  725.  
  726.  
  727.  
  728.  
  729.         --------------------------------------------------------------------
  730.         Page 12                       ChatBox                        Page 12
  731.         --------------------------------------------------------------------
  732.  
  733.         3.0  Notes regarding PCBTEXT files
  734.         ----------------------------------
  735.         ChatBox detects the language being used and uses the following  text 
  736.         from the appropriate PCBTEXT (PCBTEXT.???) file.
  737.  
  738.         Rec#   Default text
  739.           
  740.         97     Page ends in 30 seconds.  (Ctrl-K) Aborts .
  741.                Notes: Self explanatory.
  742.  
  743.         175    Sysop CHAT active at~                   
  744.                Notes: Written to caller log only. Time is added to end. 
  745.                          
  746.         219    Sysop CHAT ended at~                                  
  747.                Notes: Written to caller log and displayed after a chat. Time
  748.                       is added to end of line.
  749.  
  750.         327    I'm back!  Thanks for waiting~   
  751.                Notes: Displayed on return from Sysop F5. Caller's first name
  752.                       is added to end of the line.
  753.                          
  754.         333    Hello, This is @OPTEXT@.~~
  755.                Notes: Displayed in Sysop's "box" when a chat begins. Chatbox
  756.                       will replace @OPTEXT@ with Sysop's name in CBSETUP.
  757.  
  758.         409    Operator paged at~ 
  759.                Notes: Written to caller log only. Time is added to the end
  760.                       of the line, followed by the REASON the caller paged
  761.                       (if used).
  762.  
  763.         418    Press (Enter) to continue
  764.                Notes: Self explanatory.
  765.  
  766.         436    ______ has exited to DOS.  Please wait ...
  767.                Notes: Displayed when Sysop F5'd to DOS. Sysop's name in
  768.                       CBSETUP is added to the beginning of the line.
  769.  
  770.         ADDITIONAL NOTES:
  771.         -----------------
  772.  
  773.         @FIRST@ (caller's first name) may be used in any line. 
  774.                               
  775.         ChatBox replaces ~ characters with hard spaces in the same fashion 
  776.         PCBoard does in PCBTEXT.
  777.           
  778.         The  text  used  from PCBTEXT files is  simple  informational  text. 
  779.         ChatBox does not support the use of %FILENAME conventions in any  of 
  780.         the above PCBTEXT parameters.
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.  
  790.  
  791.  
  792.  
  793.  
  794.  
  795.         --------------------------------------------------------------------
  796.         Page 13                       ChatBox                        Page 13
  797.         --------------------------------------------------------------------
  798.  
  799.         3.1  Notes Regarding The F4 Function Key
  800.         ----------------------------------------
  801.         ChatBox follows the F4 toggle from PCBoard. This allows the Sysop to 
  802.         easily toggle paging on or off at any time. 
  803.           
  804.         The Sysop may also set the F4 toggle while in ChatBox. 
  805.  
  806.         To determine if you have F4 toggled ON in PCBoard, look at PCBoard's 
  807.         call waiting screen. The very center information block will indicate 
  808.         whether  "Page  Bell is Off" or "Page Bell is On".  If  you  are  in 
  809.         PCBoard  locally or a caller is on-line, you can determine if F4  is 
  810.         toggled on by the (B) on the very bottom status line. There may be a 
  811.         "P"  or  "A"  in the parenthesis with the  "B",  (PAB),  (AB),  etc. 
  812.         depending  on  how other toggles are set in PCBoard.  If  a  "B"  is 
  813.         there, the page bell is toggled on.
  814.           
  815.  
  816.         3.2  Notes regarding SOUND.BAT
  817.         ------------------------------
  818.         SOUND.BAT is called if #8 has been selected for the type of sound to 
  819.         make when paging.  ChatBox will shell out to SOUND.BAT every  couple 
  820.         of seconds instead of making a selected noise. 
  821.  
  822.         This allows the Sysop to make their own noise, screen displays, etc.
  823.           
  824.         Note:   We  have  received  reports  that  sound  cards  have   been 
  825.         successfully  used to create page sounds in SOUND.BAT. It should  be 
  826.         noted  that this process could have difficulties.  It would  not  be 
  827.         surprising  if the drivers which typically must be loaded for  sound 
  828.         cards  to work created problems with communications  programs.  Test 
  829.         carefully  thoroughly  if you plan on using a sound card  to  create 
  830.         page sounds.
  831.                          
  832.         In all cases, keep whatever is placed in SOUND.BAT small and fast.
  833.  
  834.  
  835.         3.3  Notes regarding text file displays
  836.         ---------------------------------------
  837.         ChatBox will display text files if indicated in certain text prompts 
  838.         in  CBSETUP. These text files support PCBoard color macros.  Because 
  839.         ChatBox has been designed to be as small as possible for "shell  to" 
  840.         door  purposes,  ANSI  capabilities in these text  files  have  been 
  841.         intentionally omitted.
  842.                                         
  843.         These  text  files also support the use of the  @cls@  clear  screen 
  844.         macro,  as well as the use of @first@ for the caller's  first  name. 
  845.         Support  for  a mutlitude of @info@ macros  has  been  intentionally 
  846.         omitted  to  keep memory consumption as low as possible for  use  in 
  847.         "shell to" door processes.
  848.  
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861.         --------------------------------------------------------------------
  862.         Page 14                       ChatBox                        Page 14
  863.         --------------------------------------------------------------------
  864.  
  865.         4.0  Sysop function keys
  866.         ------------------------
  867.         ChatBox  follows F3 (printer on/off), F4 (page bell on/off)  and  F9 
  868.         (display  on/off)  toggles  from PCBoard. If F3 is on, ChatBox  will 
  869.         print any information sent to the caller log to the printer also. If
  870.         F9 is off, ChatBox will clear the screen after an unsuccessful  page 
  871.         attempt. The F4 key is explained in detail elsewhere in this manual.
  872.  
  873.         Sysops may drop to DOS using the F5 key if F5 drop to DOS is enabled 
  874.         in PCBSETUP for the node.
  875.  
  876.         4.1  Technical notes
  877.         --------------------
  878.         ChatBox has been designed to run specifically with  PCBoard versions
  879.         14.5 & 14.5a. ChatBox will not run with earlier versions of  PCBoard 
  880.         or with other brands of software.
  881.  
  882.         Carrier is monitored by ChatBox. Should a caller drop carrier  while 
  883.         in  ChatBox they will be returned to PCBoard, which will detect  the 
  884.         "no carrier" status and cycle appropriately.
  885.                   
  886.         ChatBox works with non-standard com ports ,addresses, and IRQs. COM1 
  887.         is address 3F8/IRQ 4. COM2 is address 2F8/IRQ 3. If a COM port other 
  888.         than  1  or  2  is  used, ChatBox  will  use  the  address  and  IRQ 
  889.         information as indicated in PCBOARD.DAT for the node.
  890.  
  891.         ChatBox  gives chat time credit while the Sysop is chatting  with  a 
  892.         caller. 
  893.  
  894.         If  it is detected that the caller's communications program  is  not 
  895.         ANSI capable, ChatBox will start the chat in the regular,  non-split 
  896.         screen  chat  mode. A message will appear on the Sysop's  screen  if 
  897.         this occurs.
  898.           
  899.         4.2  Caller log entries
  900.         -----------------------
  901.         ChatBox makes pertinent entries into the caller log as follows:
  902.           
  903.         If a REASON for paging is requested, the caller's answer is appended 
  904.         to the "Operator Paged at" text and written to the CALLER files.
  905.                               
  906.         The  "Hours available" text from CBSETUP is written to CALLER  files 
  907.         if a page is attempted outside of paging times. 
  908.  
  909.         The  "Unavailable text" from CBSETUP is written to CALLER  files  if 
  910.         the  caller  lacks security to page, if F4 page is OFF,  or  if  the 
  911.         Sysop does not answer a page attempt.
  912.           
  913.         Also  see  section 3.0 page 12 for other text which  is  written  to 
  914.         CALLER files by ChatBox.
  915.           
  916.  
  917.  
  918.  
  919.  
  920.  
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927.         --------------------------------------------------------------------
  928.         Page 15                       ChatBox                        Page 15
  929.         --------------------------------------------------------------------
  930.            
  931.         4.3  Error messages
  932.         -------------------
  933.         ChatBox gives verbose installation error messages, such  as  invalid 
  934.         paths.  These messages appear and there is a short pause while  they 
  935.         are displayed. 
  936.  
  937.  
  938.         4.4  Where to receive assistance
  939.         --------------------------------
  940.         There are two ways to receive assistance should it be needed.
  941.  
  942.         YCS Support System - Home of ChatBox  813-842-8099 HST
  943.  
  944.         Sound Advice Information Services     816-436-4516 HST
  945.                                               816-436-8029 Hayes
  946.           
  947.         Sound Advice is available through PC Pursuit and StarLink  networks. 
  948.         Leave  a  message  to  Brent  Yandell  in  the  YANDELL  conference, 
  949.         currently  conference  #10 on Sound Advice. Please  understand  that 
  950.         while we call Sound Advice regularly, we do not call there everyday. 
  951.         If  your need for assistance is urgent, please direct the matter  to 
  952.         the YCS Support System.
  953.    
  954.  
  955.         4.5  Disclaimer and warranty
  956.         ----------------------------
  957.         ChatBox  is  a  shareware product. ChatBox may be  uploaded  to  BBS 
  958.         systems as long as copyright notices are not removed and no  changes 
  959.         are  made  to  the program. There are no  warranties,  expressed  or 
  960.         implied,  for  unregistered copies of ChatBox.  Sysops  who  install 
  961.         ChatBox on their systems assume any and all liabilities for anything 
  962.         which may result as a consequence of running ChatBox. For registered 
  963.         copies of ChatBox, Yandell Computer Services warrants  that  ChatBox 
  964.         will perform as described in this documentation.  In the event  that 
  965.         ChatBox does not perform as specified, Yandell Computer Services may 
  966.         elect  to fix ChatBox or refund the amount paid, if notified  within 
  967.         30 days of registration.
  968.  
  969.         Under no circumstances shall Yandell Computer Services or the author
  970.         of ChatBox be liable for any loss of profit or  any  other  damages, 
  971.         including but not limited to special, incidental, consequential,  or 
  972.         other damages, arising out of the use or inability to use ChatBox.
  973.  
  974.         PCBoard is a registered trademark of Clark Development Co. Inc.
  975.         DESQview is a registered trademark of Quarterdeck Office Systems.
  976.  
  977.  
  978.         4.6  About the author
  979.         ---------------------
  980.         L.  Brent Yandell has been involved in telecommunications  for  five 
  981.         years,  and has been writing, updating, and continuously  supporting 
  982.         BBS `doors' for four years. Many Sysops will be familiar with PCBFV, 
  983.         the popular PCBoard File Viewer, and QReader, the `full screen' text 
  984.         door for PCBoard.
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993.         --------------------------------------------------------------------
  994.         Page 16                       ChatBox                        Page 16
  995.         --------------------------------------------------------------------
  996.  
  997.         4.7  Acknowledgments
  998.         --------------------
  999.         Appreciation and many thanks are in order for the following people:
  1000.                                         
  1001.         Roy  Timberman  of Sound Advice Information Systems for  making  his 
  1002.         twenty node system completely available for testing ChatBox, and for 
  1003.         providing a conference area for its support.
  1004.  
  1005.         Jim Brewer for overall project review.
  1006.                          
  1007.         Tim Yandell for editing and proofing this documentation.
  1008.                                              
  1009.         A special thanks to all ChatBox beta testers.
  1010.  
  1011.  
  1012.         4.8  Revision history
  1013.         ---------------------
  1014.         Date       Version    Details
  1015.         --------   -------    -------
  1016.         06-14-91   1.0        ChatBox initial release.
  1017.  
  1018.         08-10-91   1.1        See the enclose FEATURES.NEW file.
  1019.  
  1020.         5.0  Registering ChatBox
  1021.         ------------------------
  1022.         ChatBox  is not free software. ChatBox must be registered  no  later 
  1023.         than 30 days after installation. 
  1024.           
  1025.         Registration is $15.00 and may be paid by check, money order,  Visa, 
  1026.         Mastercard, American Express, or Discover. If registering by  credit 
  1027.         card on-line you will receive your registration number INSTANTLY!
  1028.           
  1029.         Registration  removes  the [UNREGISTERED COPY]  message  at  program 
  1030.         termination along with the corresponding brief delay.   Registration 
  1031.         also enables the use of Sysop definable colors for Split-Screen chat 
  1032.         operations.
  1033.  
  1034.         Refer to  the  enclosed file  ORDER.FRM  for  complete  registration 
  1035.         instructions.
  1036.  
  1037.